一、DeviceHelper
设备辅助类,提供了大量方法用于辅助有关数据的处理,绝大部分的方法是 SDK 内部会使用到,不禁止开发者调用,但是不推荐使用。
- 以下方法说明中明确提供不推荐使用的方法,即为不建议开发者调用或者是开发者不应该进行任何数据修改。
- 以下文档中未提及的方法均属于不推荐使用的方法
二、Reference
以下为此类中关联的Class及相关说明
类名 | 类型 | 说明 |
---|---|---|
暂无 | - | - |
三、Methods
以下方法为开发过程常用的方法说明,参数说明及返回值说明。此处仅提供了推荐开发者使用及可能需要使用的方法,部分未列出方法请根据实际情况评估调用。
默认情况下,不推荐未列出的其它方法,即使是开放的方法,因为部分方法可能仅 SDK 内部使用。
3.1、generateDeviceTag
@NotNull
public static String generateDeviceTag(String mac, String pid)
- 方法说明:
静态方法,通过 mac 与 pid 生成标准的设备标识,该标识可用于任何需要使用设备标识的地方
- 参数说明:
参数名 | 类型 | 说明 |
---|---|---|
mac | String | 设备 mac |
pid | String | 设备产品ID |
- 返回值:String,设备标识;当参数有效非空时,将根据规则成功有效的设备标识,否则返回空字符串
3.2、separateMacAndPidFromDeviceTag
@NotNull
public static String[] separateMacAndPidFromDeviceTag(String devTag)
- 方法说明:
静态方法,从设备标识中获取 mac 与 pid 参数,请注意这里并不保证返回的数据一定是正确的,仅按规则进行拆解获取到 mac 与 pid,若设备标识来自 SDK 或由设备自身生成,则能拆解出正确的 mac 与 pid
- 参数说明:
参数名 | 类型 | 说明 |
---|---|---|
devTag | String | 设备标识 |
- 返回值:String[],mac 与 pid;拆解成功时返回2个元素的字符串数组,第1个字符串为 mac,第二个字符串为 pid,拆解不成功时返回2个元素均为空字符串
3.3、getPairingSessionId
public static short getPairingSessionId(String deviceMac)
- 方法说明:
静态方法,获取设备的 pairingId,该值在 ==0 时无效
- 参数说明:
参数名 | 类型 | 说明 |
---|---|---|
deviceMac | String | 设备 mac 地址 |
- 返回值:short,配对ID;SDK 与设备建立连接的凭证,返回0时无效
3.4、getPairingSessionKey
@NotNull
public static byte[] getPairingSessionKey(String deviceMac)
- 方法说明:
静态方法,获取设备的 pairingKey
- 参数说明:
参数名 | 类型 | 说明 |
---|---|---|
deviceMac | String | 设备 mac 地址 |
- 返回值:byte[],配对密钥;SDK 与设备建立连接的凭证加密使用的密钥,返回值不为 null,不存在配对密钥时返回空字节数组
四、更新日志
日期 | 更新内容 |
---|---|
2018-08-22 | 初稿,自 X-MQTT SDK v6.2版本起 |